Fix docs DX: consistent patterns, narrative guides, CI smoke tests#77
Merged
Larry-Osakwe merged 1 commit intomainfrom Feb 24, 2026
Merged
Fix docs DX: consistent patterns, narrative guides, CI smoke tests#77Larry-Osakwe merged 1 commit intomainfrom
Larry-Osakwe merged 1 commit intomainfrom
Conversation
Larry-Osakwe
force-pushed
the
larry/docs-dx-overhaul
branch
from
1d431d4 to
d65f707
Compare
Customer reported broken AccessContext patterns in docs — this overhaul fixes the root cause (duplicated code in MDX files) and adds CI guardrails so examples can't silently drift from the SDK API again. - Rewrite root README with value prop, decision table, correct patterns - Convert docs/ MDX files to narrative-only guides (no code duplication) - Fix delegated_access example: add missing ctx: Context parameter - Fix stale AccessContext = None docstring in provider.py - Add smoke tests for all package examples (mcp, mcp-fastmcp, oauth) - Rename docs nav group from "Examples" to "Guides"
Larry-Osakwe
force-pushed
the
larry/docs-dx-overhaul
branch
from
d65f707 to
0229a79
Compare
mnoble
approved these changes
Feb 24, 2026
Contributor
mnoble
left a comment
mnoble
left a comment
There was a problem hiding this comment.
Looks good overall. 👍
I love that you added tests for the examples, but they are pretty useless, imo 😕. Only testing that the module has certain properties, and none of the logic within, doesn't really do much.
Not a blocker right now, but it'd be nice to flesh them out in the future to ensure our examples are legit.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
keycardai-mcpandkeycardai-mcp-fastmcp, removed ~300 lines of redundant setup instructionsmcp-server-auth.mdx,fastmcp-integration.mdx, andmcp-client-usage.mdx; they now explain concepts and link to the canonical package examples. Renamed nav group from "Examples" to "Guides"ctx: Contextparameter topackages/mcp/examples/delegated_access/main.py(the@grantdecorator requires bothAccessContextandContext); fixed staleAccessContext = Nonedocstring inprovider.py; fixedaccess→auth_providernaming inpackages/mcp/README.mdtest_examples.pyto all 3 packages that import each example viaimportliband verify expected objects exist. The@grantdecorator validates function signatures at import time, so these catch parameter bugs like Ellie's report. FastMCP tests mockDefaultClientFactoryto prevent real HTTP calls duringAuthProvider.__init__Context
Customer (Ellie) reported that
docs/examples/mcp-server-auth.mdxshowedaccess_ctx: AccessContext = Nonewhich doesn't match the actual API. Root cause: code was duplicated in MDX files and drifted from the package examples. This PR fixes the immediate bugs and makes the drift structurally impossible going forward.Test plan
packages/oauth— 104 passedpackages/mcp— 623 passed, 16 skipped (interactive tests)packages/mcp-fastmcp— 51 passedjust test-coverage) should pass with no coverage regressions